Set sphinx module path #516
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sphinx module path should be set to "../src" not ".." for autodoc to work locally when typing "make html" from the "docs" folder. If not, sphinx-build might use a source file from pytest-qt installed in site-packages outside the git repo.
|
Thanks! Seems we never noticed because on RTD we install pytest-qt on the virtualenv. 👍 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Sphinx module path should be set to
../srcnot..for sphinx autodoc extension to work locally when typingmake htmlfrom thedocsfolder. If not,sphinx-buildmight use a source file from pytest-qt installed in the pythonsite-packagesdirectory outside the git repo which is obviously not correct (and very frustrating to debug :) )